/* ###
 * IP: GHIDRA
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *      http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package ghidra.app.plugin.core.functiongraph;

import ghidra.app.plugin.core.functiongraph.graph.FunctionGraph;
import ghidra.app.plugin.core.marker.MarginProviderSupplier;
import ghidra.framework.plugintool.ServiceInfo;

/**
 * A service that allows clients to add custom margins in the {@link FunctionGraph} UI.
 */
@ServiceInfo(defaultProvider = FunctionGraphPlugin.class)
public interface FunctionGraphMarginService {

	/**
	 * Add a marker margin supplier to Function Graph's primary window.  The supplier will be called
	 * for each node in the graph.
	 *
	 * @param supplier the supplier.
	 */
	public void addMarkerProviderSupplier(MarginProviderSupplier supplier);

	/**
	 * Removes the given margin supplier from the Function Graph's UI.
	 *
	 * @param supplier the supplier.
	 */
	public void removeMarkerProviderSupplier(MarginProviderSupplier supplier);
}
